Search results

Types

Classes
Interfaces
Enums
Functions
Type aliases
Constants

Members

Properties
Methods
Getters
Setters
Enum members
Show privates

Other

In this module only
index / detritus-client-socket / Socket_2

Class Socket

extends EventSpewerclass EventSpewerdetritus-utils/EventSpewer

Defined in media

Constructor

constructor(
gateway: Socketclass Socketdetritus-client-socket/Socket,
options: SocketOptionsinterface SocketOptionsdetritus-client-socket/SocketOptions
)

Properties

state: SocketStatesenum SocketStatesdetritus-client-socket/SocketStates = SocketStates.CLOSEDenum SocketStatesdetritus-client-socket/SocketStates[src]
_heartbeat: {
ack: boolean,
lastAck: null | number,
lastSent: null | number,
interval: Intervalclass Intervaldetritus-utils/Interval,
intervalTime: null | number,
nonce: null | number
} = {
ack: false,
lastAck: null,
lastSent: null,
interval: Intervalclass Intervaldetritus-utils/Interval,
intervalTime: null,
nonce: null
}[src]
bucket = Bucketclass Bucketdetritus-client-socket/Bucket[src]
forceMode: MediaEncryptionModesenum MediaEncryptionModesdetritus-client-socket/MediaEncryptionModes | null = null[src]
gateway: Socketclass Socketdetritus-client-socket/Socket[src]
promises = Set<{reject: Functionexternal Function, resolve: Functionexternal Function}>external Set[src]
protocol: MediaProtocolsenum MediaProtocolsdetritus-client-socket/MediaProtocols | null = null[src]
socket: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket | null = null[src]
ssrcs = {audio: Map<number, string>external Map, video: Map<number, string>external Map}[src]
transport: Socketclass Socketdetritus-client-socket/Socket | null = null[src]

Methods

setProtocol(value: MediaProtocolsenum MediaProtocolsdetritus-client-socket/MediaProtocols): void[src]
setState(value: SocketStatesenum SocketStatesdetritus-client-socket/SocketStates): void[src]
ssrcToUserId(
ssrc: number,
type: MediaSSRCTypesenum MediaSSRCTypesdetritus-client-socket/MediaSSRCTypes = MediaSSRCTypes.AUDIOenum MediaSSRCTypesdetritus-client-socket/MediaSSRCTypes
): null | string[src]
userIdToSSRC(
userId: string,
type: MediaSSRCTypesenum MediaSSRCTypesdetritus-client-socket/MediaSSRCTypes = MediaSSRCTypes.AUDIOenum MediaSSRCTypesdetritus-client-socket/MediaSSRCTypes
): null | number[src]
connect(endpoint?: string): void[src]
decode(data: any): any[src]
disconnect(
code: number = SocketCloseCodes.NORMALenum SocketCloseCodesdetritus-client-socket/SocketCloseCodes,
reason?: string
): void[src]
encode(data: any): null | string[src]
handle(data: any): void[src]
kill(error?: any): void[src]
onClose(
target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket,
event: {code: number, reason: string}
): void[src]
onError(target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket, event: {error: any} | any): void[src]
onMessage(
target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket,
event: {data: any, type: string}
): void[src]
onOpen(target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket): void[src]
ping(timeout?: number): Promise<any>external Promise[src]
send(
op: number,
d: any,
callback?: Functionexternal Function,
direct: boolean = false
): void[src]
heartbeat(fromInterval: boolean = false): void[src]
setHeartbeat(data: Hellointerface Hellodetritus-client-socket/MediaGatewayPackets/Hello): void[src]
transportConnect(data: Readyinterface Readydetritus-client-socket/MediaGatewayPackets/Ready): void[src]
sendClientConnect(callback?: Functionexternal Function): void[src]
sendSelectProtocol(
options: {
codecs?: Array<any>external Array,
data: {address: string, port: number, mode: string},
experiments?: Array<any>external Array,
protocol?: MediaProtocolsenum MediaProtocolsdetritus-client-socket/MediaProtocols | string,
rtcConnectionId?: string
},
callback?: Functionexternal Function
): void[src]
sendSpeaking(
options: {
delay?: number,
ssrc?: number,
soundshare?: boolean,
voice?: boolean
},
callback?: Functionexternal Function
): void[src]
sendStateUpdate(
options: {
selfDeaf?: boolean,
selfMute?: boolean,
selfVideo?: boolean
} = {},
callback?: Functionexternal Function
): void[src]
on(event: string | symbol, listener: (...args: any[]) => void): Socketclass Socketdetritus-client-socket/Socket[src]
11 more overloads
on(
event: "close",
listener: (payload: {code: number, reason: string}) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(event: "killed", listener: () => any): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "open",
listener: (target: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "packet",
listener: (packet: Packetinterface Packetdetritus-client-socket/MediaGatewayPackets/Packet) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(event: "ready", listener: () => any): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "socket",
listener: (socket: BaseSocketclass BaseSocketdetritus-client-socket/BaseSocket) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "state",
listener: (
__namedParameters: {state: SocketStatesenum SocketStatesdetritus-client-socket/SocketStates}
) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "transport",
listener: (transport: Socketclass Socketdetritus-client-socket/Socket) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "transportReady",
listener: (transport: Socketclass Socketdetritus-client-socket/Socket) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(
event: "warn",
listener: (error: Errorexternal Error) => any
): Socketclass Socketdetritus-client-socket/Socket[src]
on(event: string | symbol, listener: (...args: any[]) => void): Socketclass Socketdetritus-client-socket/Socket[src]